Loading TOC...

MarkLogic 9 Product Documentation
GET /manage/v2/databases/{id|name}/view-schemas/{schema-name}/views/{id|name}/properties

Summary

This resource address returns the properties of the specified SQL View for the specified database.

URL Parameters
format The format of the returned data. Can be either json or xml (default). This value overrides the Accept header if both are present.
Request Headers
Accept The expected MIME type of the response. If the format parameter is present, it takes precedence over the Accept header.
Content-type The MIME type of the data in the response body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.
Response Headers
Content-type The MIME type of the data in the response body. Depending upon the value of the format parameter or Accept header, one of application/xml, application/json, or text/html.

Response

Upon success, MarkLogic Server returns status code 200 (OK), and the response body contains the requested data. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

This operation requires the manage-user role, or the following privilege:

http://marklogic.com/xdmp/privileges/manage

Usage Notes

The structure of the output returned from this REST API is as follows:

view-name

The name of a relational view. This will be the SQL view name.

schema-name

The name of a relational schema. This will be the SQL schema name.

element-scope

A view scope defined by a root element.

This is a complex structure with the following children:

namespace-uri

The namespace URI of an element.

localname

A local name of an element.

collection-scope

A view scope defined by a collection.

This is a complex structure with the following children:

collection

ordered

Whether the columns in the view must appear in order in the document.

columns

The columns in the view.

This is a complex structure with the following children:

column

A column in a relational view defined over some range index.

This is a complex structure with the following children:

column-name

The name of the column in the relational view. This will be the SQL column name.

cts:base-reference

fields

This is a complex structure with the following children:

field

This is a complex structure with the following children:

field-name

permissions

The default set of permissions used in document creation.

This is a complex structure with the following children:

permission

Permission representation.

This is a complex structure with the following children:

role-name

The Role name (unique)

capability

The action/task permitted by a permission

Example


http://localhost:8002/manage/v2/databases/SQLschemas/view-schemas/main/views/myTable1/properties

==> Returns the properties of the "myTable1" View for the Schemas database.

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.